com.inscoper.nbo.ImmersionLiquid

Represents the XML element ImmersionLiquid. More...

Inherits from com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	ImmersionLiquid()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setType(ImmersionLiquidType_Type value) Sets the value of the Type attribute.
ImmersionLiquidType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setRefractiveIndex(float value) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
boolean	hasRefractiveIndex() Checks whether the optional RefractiveIndex attribute is present.
void	setViscosity(float value) Sets the value of the Viscosity attribute.
float	getViscosity() Returns the value of the Viscosity attribute.
void	resetViscosity() Resets the Viscosity attribute to an unset state.
boolean	hasViscosity() Checks whether the optional Viscosity attribute is present.
ImmersionLiquid	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	ImmersionLiquid(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ImmersionLiquid obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the optional LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.ImmersionLiquid;

Represents the XML element ImmersionLiquid.

This element refers to the Immersion Liquid that was used with this Objective during the Acquisition of this Image. According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water, glycerol or any media in which the Specimen is submerged during acquisition in case a Cover Glass is not used) specified as suitable for use in the space between the front of an Objective lens and the Cover Glass or the Object itself (i.e., such as is the case for Dipping Objectives). Refer to ISO 8036-1 for more details on Immersion Oil. Please NOTE: Because the Immersion Liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Also please NOTE: In case a Cover Glass is not used during Acquisition the Immersion Liquid is most often referred to as Dipping Medium. Examples of Dipping Media include, water-based solutions (biological buffers, culture media, other water-based solutions) and organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); Ethanol].

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

function ImmersionLiquid

public ImmersionLiquid()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

function setID

public void setID(
    LSID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public LSID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this component.

function setType

public void setType(
    ImmersionLiquidType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field records the general category to which this Immersion Liquid belongs.

function getType

public ImmersionLiquidType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field records the general category to which this Immersion Liquid belongs.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

This field records the general category to which this Immersion Liquid belongs.

function hasType

public boolean hasType()

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the general category to which this Immersion Liquid belongs.

function setRefractiveIndex

public void setRefractiveIndex(
    float value
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

function getRefractiveIndex

public float getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

Return: The value of the attribute

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

function resetRefractiveIndex

public void resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

function hasRefractiveIndex

public boolean hasRefractiveIndex()

Checks whether the optional RefractiveIndex attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

function setViscosity

public void setViscosity(
    float value
)

Sets the value of the Viscosity attribute.

Parameters:

value The value to set

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

function getViscosity

public float getViscosity()

Returns the value of the Viscosity attribute.

Return: The value of the attribute

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

function resetViscosity

public void resetViscosity()

Resets the Viscosity attribute to an unset state.

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

function hasViscosity

public boolean hasViscosity()

Checks whether the optional Viscosity attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

function __internal_create

public static ImmersionLiquid __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Protected Functions Documentation

function ImmersionLiquid

protected ImmersionLiquid(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

function getCPtr

protected static long getCPtr(
    ImmersionLiquid obj
)

Updated on 2026-02-13 at 16:10:58 +0100